/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui.option;

import java.awt.Color;
import java.awt.Dimension;

import javax.swing.JLabel;
import javax.swing.JSlider;

import net.sf.freecol.client.gui.panel.Utility;
import net.sf.freecol.common.option.Option;


/**
 * This class provides a JSlider as visualization for an
 * {@link net.sf.freecol.common.option.IntegerOption} or one of its
 * subclasses.
 */
public class SliderOptionUI< T extends Option< Integer > > extends OptionUI< T >
{

    private final JSlider slider = new JSlider( );

    /**
     * Creates a new <code>SliderOptionUI</code> for the given
     * <code>IntegerOption</code>.
     *
     * @param option The <code>IntegerOption</code> to make a user
     *     interface for.
     * @param editable boolean whether user can modify the setting
     */
    public SliderOptionUI( final T option, boolean editable )
    {
        super( option, editable );

        slider.setBorder( Utility.localizedBorder( super.getJLabel( ).getText( ),
                                                   Color.BLACK ) );
        slider.setOrientation( JSlider.HORIZONTAL );
        slider.setPreferredSize( new Dimension( 500, 50 ) );
        slider.setPaintLabels( true );
        slider.setPaintTicks( true );
        slider.setExtent( 0 );

        initialize( );
    }


    // Implement OptionUI

    /**
     * {@inheritDoc}
     */
    @Override
    public final JLabel getJLabel( )
    {
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public JSlider getComponent( )
    {
        return slider;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void updateOption( )
    {
        getOption( ).setValue( slider.getValue( ) );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void reset( )
    {
        slider.setValue( getOption( ).getValue( ) );
    }
}
